[KIP-932] - Update ShareConsumer Api docs#2295
Open
Kaushik Raina (k-raina) wants to merge 1 commit into
Open
Conversation
Kaushik Raina (k-raina)
requested review from
a team and
Matthew Seal (MSeal)
as code owners
|
🎉 All Contributor License Agreements have been signed. Ready to merge. |
There was a problem hiding this comment.
Pull request overview
Updates the ShareConsumer user-facing API documentation (C-embedded docstrings) to reflect KIP-932 behavior and clarify usage/semantics for subscription, polling, acknowledgements, shutdown, and thread-safety expectations.
Changes:
- Expanded method docstrings for
subscribe(),poll(),acknowledge()/acknowledge_offset(), andclose()with clearer behavioral details and error conditions. - Added high-level ShareConsumer class documentation describing record lock/acknowledgement modes, polling requirements, and explicit thread-safety warnings.
- Removed the outdated internal TODO block in favor of user-facing documentation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary